/*
 * Copyright 2011 Mark Davidson.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package org.dctmcommons;

import com.documentum.fc.client.IDfSession;
import com.documentum.fc.common.DfException;

/**
 * Fluent interface for tearing down objects. Please note that no transactions
 * are used during the operation.
 * @author Mark Davidson
 */
public interface ITeardownBuilder {

	/**
	 * Includes the base folder.
	 * @return The ITeardownBuilder instance
	 */
	public ITeardownBuilder includeBaseFolder();
	
	/**
	 * Includes snapshots.
	 * @return The ITeardownBuilder instance
	 */
	public ITeardownBuilder includeSnapshots();
	
	/**
	 * Includes virtual documents.
	 * @return The ITeardownBuilder instance
	 */
	public ITeardownBuilder includeVirtualDocs();

	/**
	 * Includes documents.
	 * @return The ITeardownBuilder instance
	 */
	public ITeardownBuilder includeDocuments();
	
	/**
	 * Includes folders.
	 * @return The ITeardownBuilder instance
	 */
	public ITeardownBuilder includeFolders();
	
	/**
	 * Includes all objects.
	 * @return The ITeardownBuilder instance
	 */
	public ITeardownBuilder includeAllObjects();
	
	/**
	 * Includes all child objects - the base folder remains.
	 * @return The ITeardownBuilder instance
	 */
	public ITeardownBuilder includeAllChildObjects();
	
	/**
	 * Performs the teardown. This method should be called last.
	 * @param session The session
	 * @throws DfException The repository exception
	 */
	public void build(IDfSession session) throws DfException;
}
